docs: add [skip ci] documentation to CONTRIBUTING.md#8877
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughAdded new "Skipping CI" documentation section to CONTRIBUTING.md describing commit-message keywords ( Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
CONTRIBUTING.md (1)
1-16:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAdd
Skipping CIto the TOC.The new section at Line 361 is not linked in the top TOC, so document navigation is incomplete.
Also applies to: 361-361
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@CONTRIBUTING.md` around lines 1 - 16, The table of contents is missing an entry for the new "Skipping CI" section introduced at line 361; update the TOC in CONTRIBUTING.md by adding a "Skipping CI" link (with the correct markdown anchor `#skipping-ci`) under the appropriate subsection (likely under "Preparing pull requests" or where other PR workflow items live) so the new section is reachable from the top navigation; ensure the link text exactly matches the section heading "Skipping CI" and follows the numbering/indent style used for neighboring TOC entries.
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
411-429: ⚡ Quick winAvoid a brittle hardcoded workflow inventory.
This explicit list will drift as workflows evolve. Consider reframing as examples and linking to
.github/workflows/to keep this section current.As per coding guidelines, "**/*.md: Remember that documentation must be updated with the latest information."
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@CONTRIBUTING.md` around lines 411 - 429, The explicit inventory of workflows (e.g., premerge, premerge-min, premerge-gpu, CodeQL analysis, Docker build, Blossom-CI, ChatOps, Integration tests, Cron jobs, Weekly preview, Conda build) is brittle and will drift; update the CONTRIBUTING.md text to present these as representative examples rather than a definitive list, remove the hardcoded enumeration, and add a short sentence pointing readers to the repository's workflows directory (so maintainers can see current workflow names) along with guidance to update the docs whenever workflows change.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 389-393: Update the fenced code block that currently shows the
example commit message containing "commit message" and "skip-checks: true" to
include a language specifier (e.g., add "text" or "md" after the opening `````),
so the block becomes `````text` (or `````md`) to satisfy MD040 and keep the
markdown lint-clean; locate the fenced block in CONTRIBUTING.md that contains
the literal "commit message" and modify its opening fence accordingly.
---
Outside diff comments:
In `@CONTRIBUTING.md`:
- Around line 1-16: The table of contents is missing an entry for the new
"Skipping CI" section introduced at line 361; update the TOC in CONTRIBUTING.md
by adding a "Skipping CI" link (with the correct markdown anchor `#skipping-ci`)
under the appropriate subsection (likely under "Preparing pull requests" or
where other PR workflow items live) so the new section is reachable from the top
navigation; ensure the link text exactly matches the section heading "Skipping
CI" and follows the numbering/indent style used for neighboring TOC entries.
---
Nitpick comments:
In `@CONTRIBUTING.md`:
- Around line 411-429: The explicit inventory of workflows (e.g., premerge,
premerge-min, premerge-gpu, CodeQL analysis, Docker build, Blossom-CI, ChatOps,
Integration tests, Cron jobs, Weekly preview, Conda build) is brittle and will
drift; update the CONTRIBUTING.md text to present these as representative
examples rather than a definitive list, remove the hardcoded enumeration, and
add a short sentence pointing readers to the repository's workflows directory
(so maintainers can see current workflow names) along with guidance to update
the docs whenever workflows change.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 13507825-e844-4464-9e6e-440790e94a71
📒 Files selected for processing (1)
CONTRIBUTING.md
1 participant
Description
Adds a new "Skipping CI" section to CONTRIBUTING.md documenting the native GitHub Actions commit-message mechanism for skipping CI pipelines.
The section covers:
[skip ci],[ci skip],[no ci],[skip actions],[actions skip])skip-checks: truetrailer alternative[skip ci]No workflow YAML changes needed — GitHub Actions handles this natively.
Types of changes
./runtests.sh -f -u --net --coverage../runtests.sh --quick --unittests --disttests.make htmlcommand in thedocs/folder.